Fix a few documentation issues
authorTimm Bäder <mail@baedert.org>
Sat, 8 Jul 2017 07:56:41 +0000 (09:56 +0200)
committerMatthias Clasen <mclasen@redhat.com>
Thu, 20 Jul 2017 01:27:15 +0000 (21:27 -0400)
gtk/gtkbuilder.c
gtk/gtkcolorbutton.c
gtk/gtkdrawingarea.c
gtk/gtkeventcontroller.c
gtk/gtkfilechooserdialog.c
gtk/gtkfilechoosernative.c
gtk/gtkmain.c
gtk/gtkorientable.c

index 4c03243d1a3a402e61a0c153d21dc7529de8148b..eda155563c23f31af82a5d7bf4d19bb8241c776d 100644 (file)
  * specified in an XML format which can be roughly described by the
  * RELAX NG schema below. We refer to these descriptions as “GtkBuilder
  * UI definitions” or just “UI definitions” if the context is clear.
- * Do not confuse GtkBuilder UI Definitions with
- * [GtkUIManager UI Definitions][XML-UI], which are more limited in scope.
- * It is common to use `.ui` as the filename extension for files containing
- * GtkBuilder UI definitions.
  *
  * [RELAX NG Compact Syntax](https://git.gnome.org/browse/gtk+/tree/gtk/gtkbuilder.rnc)
  *
index 2d63e8d175dec22b1beb6050e396b032b4e6dbff..bfe716b1fc0e279654fe5c74d53fee2024117133 100644 (file)
@@ -48,7 +48,7 @@
  * SECTION:gtkcolorbutton
  * @Short_description: A button to launch a color selection dialog
  * @Title: GtkColorButton
- * @See_also: #GtkColorSelectionDialog, #GtkFontButton
+ * @See_also: #GtkFontButton
  *
  * The #GtkColorButton is a button which displays the currently selected
  * color and allows to open a color selection dialog to change the color.
@@ -251,7 +251,7 @@ gtk_color_button_class_init (GtkColorButtonClass *klass)
    * @widget: the object which received the signal.
    *
    * The ::color-set signal is emitted when the user selects a color.
-   * When handling this signal, use gtk_color_button_get_rgba() to
+   * When handling this signal, use gtk_color_chooser_get_rgba() to
    * find out which color was just selected.
    *
    * Note that this signal is only emitted when the user
index 12d46e747535ba03e53b656e7c23b1d243447963..c36c9838341537e9732cd35dea936f65ab76568e 100644 (file)
@@ -61,8 +61,7 @@ static GParamSpec *props[LAST_PROP] = { NULL, };
  * creating a drawing area, the application may want to connect to:
  *
  * - Mouse and button press signals to respond to input from
- *   the user. (Use gtk_widget_add_events() to enable events
- *   you wish to receive.)
+ *   the user.
  *
  * - The #GtkWidget::realize signal to take any necessary actions
  *   when the widget is instantiated on a particular display.
index 28a36890ce64c5b0247c25b5a0f94645e4ed034a..4a98c44d146c970764092c0246fb55436be82f74 100644 (file)
@@ -289,7 +289,7 @@ gtk_event_controller_get_widget (GtkEventController *controller)
  * @controller: a #GtkEventController
  *
  * Resets the @controller to a clean state. Every interaction
- * the controller did through #GtkEventController::handle-event
+ * the controller did through gtk_event_controll_handle_event()
  * will be dropped at this point.
  *
  * Since: 3.14
index 93bdd03661f88e96a3e9c7899c55e6217885fa38..833738edf82d33dd116d1f73ad8583baf79aab99 100644 (file)
@@ -45,7 +45,7 @@
  * SECTION:gtkfilechooserdialog
  * @Short_description: A file chooser dialog, suitable for “File/Open” or “File/Save” commands
  * @Title: GtkFileChooserDialog
- * @See_also: #GtkFileChooser, #GtkDialog, GtkFileChooserNative
+ * @See_also: #GtkFileChooser, #GtkDialog, #GtkFileChooserNative
  *
  * #GtkFileChooserDialog is a dialog box suitable for use with
  * “File/Open” or “File/Save as” commands.  This widget works by
index 03b7dd8d24735cfba569ea48b09b283bb8fb31da..b66e5a7d8c82f12d4a07a373e10b631ded019015 100644 (file)
@@ -230,7 +230,7 @@ G_DEFINE_TYPE_WITH_CODE (GtkFileChooserNative, gtk_file_chooser_native, GTK_TYPE
 
 /**
  * gtk_file_chooser_native_get_accept_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  *
  * Retrieves the custom label text for the accept button.
  *
@@ -249,7 +249,7 @@ gtk_file_chooser_native_get_accept_label (GtkFileChooserNative *self)
 
 /**
  * gtk_file_chooser_native_set_accept_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  * @accept_label: (allow-none): custom label or %NULL for the default
  *
  * Sets the custom label text for the accept button.
@@ -276,7 +276,7 @@ gtk_file_chooser_native_set_accept_label (GtkFileChooserNative *self,
 
 /**
  * gtk_file_chooser_native_get_cancel_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  *
  * Retrieves the custom label text for the cancel button.
  *
@@ -295,7 +295,7 @@ gtk_file_chooser_native_get_cancel_label (GtkFileChooserNative *self)
 
 /**
  * gtk_file_chooser_native_set_cancel_label:
- * @self: a #GtFileChooserNative
+ * @self: a #GtkFileChooserNative
  * @cancel_label: (allow-none): custom label or %NULL for the default
  *
  * Sets the custom label text for the cancel button.
index 06a974a032c4a990773c2196608e89b912d99637..4364e795141ccd8b1651f97063849c8ba7455d9a 100644 (file)
@@ -2420,6 +2420,7 @@ gtk_get_event_target (const GdkEvent *event)
 /**
  * gtk_get_event_target_with_type:
  * @event: a #GdkEvent
+ * @type: the type to look for
  *
  * If @event is %NULL or the event was not associated with any widget,
  * returns %NULL, otherwise returns first widget found from the event
index 0607211d559034c00b943e8091fc72c18fc85b7e..f66fe041f56278eb26265ddb13fc551937664c39 100644 (file)
@@ -33,9 +33,7 @@
  * @Title: GtkOrientable
  *
  * The #GtkOrientable interface is implemented by all widgets that can be
- * oriented horizontally or vertically. Historically, such widgets have been
- * realized as subclasses of a common base class (e.g #GtkBox/#GtkHBox/#GtkVBox
- * or #GtkScale/#GtkHScale/#GtkVScale). #GtkOrientable is more flexible in that
+ * oriented horizontally or vertically. #GtkOrientable is more flexible in that
  * it allows the orientation to be changed at runtime, allowing the widgets
  * to “flip”.
  *